home *** CD-ROM | disk | FTP | other *** search
/ Aminet 7 / Aminet 7 - August 1995.iso / Aminet / comm / mebbs / stoli10f.lha / SendToLine.Doc < prev   
Text File  |  1994-08-12  |  10KB  |  262 lines
  1.  
  2.                ******************************************
  3.                *                                        *
  4.                *     SendToLine v1.0 (C) By Marco Valk  *
  5.                *                                        *
  6.                ******************************************
  7.  
  8.  
  9.         
  10.    Well doc writing is not one off my favourite projects, but i have
  11.    to explain something.
  12.  
  13.  
  14.    WHATISIT?
  15.    ---------
  16.  
  17.    * A very simple Broadcast type Program,Just start it and press
  18.      a Line Button, the User that is on that line will be displayed and
  19.      a String Requester Pops Up.
  20.  
  21.      Just enter the message you want to send him and.....Off you go !
  22.  
  23.    * Its also can be runned from the CLI ore WorkBench, when started from
  24.      the cli Without Options, the Gui is started by default on the
  25.      MebbsNetscreen (ifit can find it, if not it will open on the Workbench)
  26.  
  27.      If it's started with the CLI Options, the GUI is not loaded and the 
  28.      Message is send to the correct line with a Clearscreen code or Not.
  29.  
  30.    * It can be made resident.
  31.  
  32.  
  33.  
  34.    HOW DOES IT WORK
  35.    ----------------
  36.  
  37.    * Well, The Line Buttons will be made vissable when a MebbsNet line
  38.      is up, so when there is only line 1 active, than ONLY the Line One
  39.      Button will be enabled.
  40.  
  41.      After you filled in the text, and press return, or SEND, the message will
  42.      be send to the user WITHOUT A Clearscreen..,. And the message will be
  43.      send.
  44.  
  45.      If you enter a Message and you press the SEND With CLS Button, a 
  46.      clearscreen code will be send before the message will be displayed to
  47.      the User.
  48.  
  49.      That's It !......
  50.  
  51.    * It is also possible to enter on your keyboard the Numbers 1 to 9, this
  52.      will also bring up the string requester in where you have to fill in the
  53.      message you want to send.
  54.  
  55.      - use the 'U' Key to UPDATE the Lines.
  56.  
  57.    * With the Menu's , you can send a textFile to a Line, Just select the
  58.      correct line, and a requester will pop up, here you can select a
  59.      textfile which will be send to that Line.
  60.  
  61.      You can send that file WITH a ClearScreen Code ore Without a CLS.
  62.  
  63.    * So: When No Line is Active, and you start the program, All Buttons
  64.      are ghosted !.
  65.  
  66.      - You Can Use the UPDATE Button to get The current status of all your
  67.        active lines ,But by default, it will show the users Name on line
  68.        1 only, but IF there were MORE Lines active than the last time SendToline
  69.        was runned, other line gadgets will be available also, just press
  70.        on the wanted Line button to see what user is on that line !
  71.  
  72.    ---------------------------------------------------------------------------
  73.  
  74.    * The Cli options are : WB,NO,NO1,CLS
  75.  
  76.      WB:  To Open On WorkBench
  77.      NO:  To Send ONLY the Text WITH a return (No system announcement lines)
  78.      NO1: To Send ONLY the Text WITHOUT a return (No system announcement lines)
  79.      CLS: To Send a ClearScreen Code Before the text is Send.
  80.  
  81.      NOTE: NO and NO1 can't be used together,only One it them is accepted
  82.            See History notes for further examples.
  83.  
  84.      1> SendToLine WB 4 "This is the Text what will be send to line 4" CLS
  85.  
  86.     In this example, The text between "" Is send to Line 4, the CLS and Wb
  87.     keyword is optional and can be Left out the commandLine, IF CLS is Left
  88.     out,No ClearScreen will be send to the User before the message is send,
  89.     If the CLS Keyword is present, a ClearScreen will be send.
  90.  
  91.     If SendToline is started with ONLY the WB option, it will open the GUI
  92.     on the Workbench, Cause by default it will try to open on your Mebbsnet-
  93.     Screen.
  94.  
  95.     So: When you type in the CLI:
  96.  
  97.     1>SendToLine
  98.  
  99.     - Than The GUI Is Started with all the Buttons etc On the MebbsnetScreen
  100.       if it Cannot find it, it will open on the WorkBenchScreen.
  101.  
  102.     1>SendToLine WB
  103.  
  104.     - Will ALWAYS open the GUI-Window on the Workbench instead of the Mebbs-
  105.       Net Screen.
  106.  
  107.     1>SendToLine ?, a Example is given how to use the CLI version (see Above)
  108.  
  109.  
  110.    * To make SendToLine resident :
  111.  
  112.    1>resident SendToLine
  113.    1>Run SendToLine
  114.  
  115.    Everytime SendToLine is started, it will be started from memory in stead
  116.    of disk.
  117.  
  118.  
  119.    INSTALLATION
  120.    ------------
  121.  
  122.    * Just copy it to your MebbsNet:C/ directory... and run it when you need
  123.      it.It *Might* be Good idea To add it to the MenuChoices.CFG file, which
  124.      can be found in the MebbsNet:Configfiles/ Directory.
  125.  
  126.      Also the reqtools.Library Must be in your LIBS: dir
  127.  
  128.    NOTE: Kickstart 2.x ore greater is needed to run this program.
  129.  
  130.  
  131.    WHY ?
  132.    -----
  133.  
  134.    * Cause Broadcast didn't worked for me, and i needed it....
  135.  
  136.  
  137.    BUGS/SUGGESTIONS
  138.    ----------------
  139.  
  140.    * Just send them to the adress below.....
  141.  
  142.  
  143.    AUTHOR & COPYRIGHTS
  144.    -------------------
  145.  
  146.    * Marco Valk
  147.      Jan VerFailleweg 470
  148.      1783 B.R Den-Helder
  149.      Holland
  150.  
  151.      DataNr: 31-2230-16836
  152.      NodeNr: 2:512/52.0
  153.      AmyNr : 39:152/109.0
  154.  
  155.      MebbsDeveloperNr: M7002
  156.  
  157.      This ProGram is FreeWare BUT CopyRighted.....Just Use it When you are
  158.      A registrated MebbsNet Sysop.
  159.  
  160.    * PerMission is hereby given to William Bowling to include this Program
  161.      in his MebbsNet Proffesional BBS System distribution package.
  162.  
  163.     OTHER PROGRAMS:
  164.     ---------------
  165.  
  166.     * StarInfo
  167.     * AutoUpdate
  168.     * RunCLI
  169.     * MakeThemYS
  170.     * SendToLine
  171.     * Members
  172.     * Bewaker
  173.     * Some Old little handy StarNet Programs
  174.  
  175.  
  176.    VERSIONS
  177.    --------
  178.  
  179. * 0.99   First Working release, no need to Make it bigger/expand it
  180.  
  181. * 1.00   Pffff Jon Witty asked me for some Options, so the UPDATE Button
  182.          was added to Get the most actual status off the Lines,This way
  183.          SendToLine can be active all of the time.
  184.          And a CLI interface was added for The CLI Users/Arexx script-
  185.          Makers.
  186.  
  187. * 1.0a   Tom Sanfeld wanted to have a Line 0 (Local Line) Also, so i decided
  188.          to add this Line too, for testing purposes ?,Note that there is NO
  189.          Button for Line 0, cause i think it would be raraly used, Sothat
  190.          Line 0 (Local) is only Available for SendToLine in CLI-Mode.
  191.  
  192. * 1.0b   Now A New option for the command Line is added, Option WB, if it's
  193.          in the command line, the GUI will be started on the workbench screen
  194.          Otherwise, it looks for a active MebbsNet Screen, and opens the Gui
  195.          on that...IF sendtoline is started WITHOUT Paramters, by default it
  196.          will open on the MebbsNet Screen, if it cannot find it, it will open
  197.          on the Workbench Screen like before.
  198.  
  199.          The Zoom Gadget in the window, will iconify the GUI in the right upper
  200.          corner, to make it full, just press the zoom gadget again, this way it
  201.          will always be on your mebbsscreen, ore WokBench screen.
  202.  
  203.          So: 1>SendToLine WB    (will open the GUI on the workbench screen)
  204.              1>SendToLine       (will look for the mebbsScreen, if it's Not
  205.                                  found,it will open on the Workbench screen)
  206.  
  207.         ALL other options are still active, so this version has also a CLI
  208.         Functon to use in Arexx-Script. (a example ArexxScriptis provided,
  209.         thanks goes to Mikael Johansson)
  210.  
  211. * 1.0c  Added Dropmenu's, these are used to send a Textfile to a LineNumber
  212.         There is NO checking done, sothat if you select a wrong invalid line,
  213.         the text will be send to that line..This way the user won't see anything
  214.         Also, there are 2 options to send a textfile, one for sending it WITHOUT
  215.         a ClearScreen Code, and one that WILL send a Clearscreen code before the
  216.         text is shown.
  217.  
  218.         BUGS: The Selected textfile has to have a EXTRA Return, ore else the
  219.               last line will be shown 2 times.
  220.  
  221. * 1.0d  Fixed a bug where you can't select a textFile in a other directory
  222.         than the current one.
  223.         output of a TextFile can be messy if the lines are longer than 70
  224.         characters, this is because of a Function that is used to send
  225.         a string to the window in the library.
  226.  
  227. * 1.0e Fixed some problems with the FileText Send option, Cause it also
  228.        displayed the last line 2 times if there was no extra return in
  229.        the textfile.
  230.        Also due to Williams Fix in a Library, A Textfile send gave problems,
  231.        cause it did not put a return code after a line (fixed)
  232.  
  233.        New option:  NO/NO1
  234.  
  235.        John Witty wanted a option to send a Line off text Without the System
  236.        announcement lines, sothat ONLY THAT text was send.
  237.        Well, Options NO and NO1 were born, it means That when option NO is used
  238.        ONLY the text With a returncode appended will be send to the line.
  239.        When Option NO1 is used, ONLY the text WITHOUT a returncode appended
  240.        after the text is send, so if you firts send a text WITH the NO1 option,
  241.        and than send a text With the NO option, than the last text will
  242.        be appended AFTER the first text that was send.
  243.  
  244.        ex: 1>SendToLine 1 "This is a Test" NO (Send the text WITH a return)
  245.        ex: 1>SendToLine 1 "This is a Test" NO1(Send the text WITHOUT a return)
  246.        ex: 1>SendToLine 1 "This is a test" NO CLS (Send the text WITH a return)
  247.                                                   (AND a ClearScreen Code     )
  248.  
  249.        The NO/NO1 Options are ONLY available in CLI-Mode, Not in the GUI
  250.  
  251. * 1.0f Begun a interface with Arexx, When first started, the port will be
  252.        called: SEND.1
  253.        Only the 'QUIT' command will work OK
  254.  
  255.        Made SendToLine Resident capable, this way if you use it as a CLI
  256.        program, It can be started from memory instead of Disk,this
  257.        way heavy usage of a Drive can be avoided.
  258.        Be sure to have the Pure bit ON, and make it resident with
  259.        the resident command (See Docs).
  260.        I made this to make things easier for mr Jon Witty, who is
  261.        using this Util in his conference door (Nice work jon).
  262.